.. _CScreenWorldMap Class: ========================== CScreenWorldMap Class ========================== .. toctree:: :maxdepth: 1 * :ref:`Overview` * :ref:`Quick Reference` * :ref:`Constructors` * :ref:`Methods` ---- .. _CScreenWorldMap_Overview: Overview --------------- .. note:: The **CScreenWorldMap** class handles the world map and interaction with it The structure used for this class is :ref:`CScreenWorldMap` ---- .. _CScreenWorldMap_QuickRef: Quick Reference --------------- +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Quick Ref** | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenWorldMap\:\:CScreenWorldMap**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:~CScreenWorldMap**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | unsigned long **CScreenWorldMap\:\:CalculateTravelTime**\(unsigned long nArea) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:CancelEngine**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenWorldMap\:\:CenterMarker**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenWorldMap\:\:CheckMouseLButton**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenWorldMap\:\:CheckMouseMove**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenWorldMap\:\:CheckMouseRButton**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenWorldMap\:\:CheckMouseWheel**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenWorldMap\:\:CheckSystemKeyCapsLock**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenWorldMap\:\:CheckSystemKeyCtrl**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenWorldMap\:\:CheckSystemKeyShift**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenWorldMap\:\:ClearChatMessages**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CScreenWorldMap\:\:DrawMap**\(:ref:`CRect`\& r) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:EngineActivated**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:EngineDeactivated**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:EngineDestroyed**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:EngineGameInit**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:EngineGameUninit**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:EngineInitialized**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenWorldMap\:\:EnterArea**\(:ref:`CResRef`\& cResArea, :ref:`CString` sEntryPoint, short nFacing, int bEncounter, unsigned long nTravelTime) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | unsigned long **CScreenWorldMap\:\:FindAreaHit**\(:ref:`CPoint`\& ptMousePos) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`CRect` **CScreenWorldMap\:\:GetAreaRect**\(unsigned long nMap, unsigned long nArea) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenWorldMap\:\:GetCapsLockKey**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:GetChatEditBoxStatus**\(:ref:`CString`\& sChatText, int\& bInputCapture) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenWorldMap\:\:GetCtrlKey**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenWorldMap\:\:GetEngineState**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | unsigned short **CScreenWorldMap\:\:GetHighlightFrame**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | unsigned char **CScreenWorldMap\:\:GetIsMapActive**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenWorldMap\:\:GetMarkerPosition**\(:ref:`CPoint`\& ptMarker) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual short **CScreenWorldMap\:\:GetNumVirtualKeys**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenWorldMap\:\:GetShiftKey**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual :ref:`CKeyInfo`\* **CScreenWorldMap\:\:GetVirtualKeys**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int\* **CScreenWorldMap\:\:GetVirtualKeysFlags**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CScreenWorldMap\:\:IsForcedRandomEncounterActive**\(:ref:`CString` sAreaName) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenWorldMap\:\:OnAreaMouseClick**\(unsigned long nArea) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenWorldMap\:\:OnCancelButtonClick**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenWorldMap\:\:OnDoneButtonClick**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:OnKeyDown**\(int nKeysFlags) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:OnKeyUp**\(int nKeysFlags) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:OnLButtonDblClk**\(:ref:`CPoint` cPoint) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:OnLButtonDown**\(:ref:`CPoint` cPoint) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:OnLButtonUp**\(:ref:`CPoint` cPoint) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenWorldMap\:\:OnMapMouseDown**\(int x, int y) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenWorldMap\:\:OnMapMouseMove**\(int x, int y) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:OnMouseMove**\(:ref:`CPoint` cPoint) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:OnMouseWheel**\(int bForward, long nTicks, unsigned long nLines, unsigned short wFlags) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:OnRButtonDown**\(:ref:`CPoint` cPoint) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:OnRButtonUp**\(:ref:`CPoint` cPoint) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenWorldMap\:\:SetAreaPalette**\(unsigned long wAreaForeground, int bColorOverride) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:SetChatEditBoxStatus**\(:ref:`CString`\& sChatText, int bInputCapture) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenWorldMap\:\:SetMapView**\(:ref:`CPoint`\& ptMapView) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:SetSystemKeyCapsLock**\(int bValue) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:SetSystemKeyCtrl**\(unsigned char bValue) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:SetSystemKeyShift**\(int bValue) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenWorldMap\:\:StartWorldMap**\(int nEngineState, long nLeavingEdge, unsigned char bInControl) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenWorldMap\:\:StopWorldMap**\(unsigned char bAreaClicked) | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:TimerAsynchronousUpdate**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenWorldMap\:\:TimerSynchronousUpdate**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenWorldMap\:\:TravelToSelected**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenWorldMap\:\:UpdateMainPanel**\() | +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ---- .. _CScreenWorldMap_Constructors: Constructors --------------- +----------------------------------------------------------------------------+------------------------------------------------------+ | **Name** | **Description** | +----------------------------------------------------------------------------+------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:CScreenWorldMap` | Constructs a ``CScreenWorldMap`` object | +----------------------------------------------------------------------------+------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:CScreenWorldMap` | Destroys a ``CScreenWorldMap`` object | +----------------------------------------------------------------------------+------------------------------------------------------+ .. _CScreenWorldMapCScreenWorldMap: CScreenWorldMap\:\:CScreenWorldMap ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Constructs a ``CScreenWorldMap`` object :: void CScreenWorldMap::CScreenWorldMap(); **Remarks** Constructs a ``CScreenWorldMap`` object ---- .. _CScreenWorldMap~CScreenWorldMap: CScreenWorldMap\:\:~CScreenWorldMap ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Destroys the ``CScreenWorldMap`` object :: virtual void CScreenWorldMap::~CScreenWorldMap(); **Remarks** Destroys the ``CScreenWorldMap`` object ---- .. _CScreenWorldMap_Methods: Methods --------------- +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | **Name** | **Description** | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:CalculateTravelTime` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:CancelEngine` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:CenterMarker` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:CheckMouseLButton` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:CheckMouseMove` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:CheckMouseRButton` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:CheckMouseWheel` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:CheckSystemKeyCapsLock` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:CheckSystemKeyCtrl` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:CheckSystemKeyShift` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:ClearChatMessages` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:DrawMap` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:EngineActivated` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:EngineDeactivated` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:EngineDestroyed` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:EngineGameInit` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:EngineGameUninit` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:EngineInitialized` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:EnterArea` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:FindAreaHit` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:GetAreaRect` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:GetCapsLockKey` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:GetChatEditBoxStatus` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:GetCtrlKey` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:GetEngineState` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:GetHighlightFrame` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:GetIsMapActive` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:GetMarkerPosition` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:GetNumVirtualKeys` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:GetShiftKey` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:GetVirtualKeys` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:GetVirtualKeysFlags` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:IsForcedRandomEncounterActive` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:OnAreaMouseClick` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:OnCancelButtonClick` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:OnDoneButtonClick` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:OnKeyDown` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:OnKeyUp` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:OnLButtonDblClk` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:OnLButtonDown` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:OnLButtonUp` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:OnMapMouseDown` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:OnMapMouseMove` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:OnMouseMove` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:OnMouseWheel` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:OnRButtonDown` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:OnRButtonUp` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:SetAreaPalette` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:SetChatEditBoxStatus` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:SetMapView` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:SetSystemKeyCapsLock` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:SetSystemKeyCtrl` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:SetSystemKeyShift` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:StartWorldMap` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:StopWorldMap` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:TimerAsynchronousUpdate` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:TimerSynchronousUpdate` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:TravelToSelected` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenWorldMap\:\:UpdateMainPanel` | | +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ ---- .. _CScreenWorldMapCalculateTravelTime: CScreenWorldMap\:\:CalculateTravelTime ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapCancelEngine: CScreenWorldMap\:\:CancelEngine ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapCenterMarker: CScreenWorldMap\:\:CenterMarker ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapCheckMouseLButton: CScreenWorldMap\:\:CheckMouseLButton ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapCheckMouseMove: CScreenWorldMap\:\:CheckMouseMove ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapCheckMouseRButton: CScreenWorldMap\:\:CheckMouseRButton ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapCheckMouseWheel: CScreenWorldMap\:\:CheckMouseWheel ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapCheckSystemKeyCapsLock: CScreenWorldMap\:\:CheckSystemKeyCapsLock ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapCheckSystemKeyCtrl: CScreenWorldMap\:\:CheckSystemKeyCtrl ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapCheckSystemKeyShift: CScreenWorldMap\:\:CheckSystemKeyShift ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapClearChatMessages: CScreenWorldMap\:\:ClearChatMessages ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapDrawMap: CScreenWorldMap\:\:DrawMap ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapEngineActivated: CScreenWorldMap\:\:EngineActivated ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapEngineDeactivated: CScreenWorldMap\:\:EngineDeactivated ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapEngineDestroyed: CScreenWorldMap\:\:EngineDestroyed ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapEngineGameInit: CScreenWorldMap\:\:EngineGameInit ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapEngineGameUninit: CScreenWorldMap\:\:EngineGameUninit ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapEngineInitialized: CScreenWorldMap\:\:EngineInitialized ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapEnterArea: CScreenWorldMap\:\:EnterArea ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapFindAreaHit: CScreenWorldMap\:\:FindAreaHit ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapGetAreaRect: CScreenWorldMap\:\:GetAreaRect ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapGetCapsLockKey: CScreenWorldMap\:\:GetCapsLockKey ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapGetChatEditBoxStatus: CScreenWorldMap\:\:GetChatEditBoxStatus ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapGetCtrlKey: CScreenWorldMap\:\:GetCtrlKey ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapGetEngineState: CScreenWorldMap\:\:GetEngineState ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapGetHighlightFrame: CScreenWorldMap\:\:GetHighlightFrame ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapGetIsMapActive: CScreenWorldMap\:\:GetIsMapActive ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapGetMarkerPosition: CScreenWorldMap\:\:GetMarkerPosition ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapGetNumVirtualKeys: CScreenWorldMap\:\:GetNumVirtualKeys ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapGetShiftKey: CScreenWorldMap\:\:GetShiftKey ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapGetVirtualKeys: CScreenWorldMap\:\:GetVirtualKeys ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapGetVirtualKeysFlags: CScreenWorldMap\:\:GetVirtualKeysFlags ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapIsForcedRandomEncounterActive: CScreenWorldMap\:\:IsForcedRandomEncounterActive ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapOnAreaMouseClick: CScreenWorldMap\:\:OnAreaMouseClick ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapOnCancelButtonClick: CScreenWorldMap\:\:OnCancelButtonClick ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapOnDoneButtonClick: CScreenWorldMap\:\:OnDoneButtonClick ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapOnKeyDown: CScreenWorldMap\:\:OnKeyDown ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapOnKeyUp: CScreenWorldMap\:\:OnKeyUp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapOnLButtonDblClk: CScreenWorldMap\:\:OnLButtonDblClk ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapOnLButtonDown: CScreenWorldMap\:\:OnLButtonDown ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapOnLButtonUp: CScreenWorldMap\:\:OnLButtonUp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapOnMapMouseDown: CScreenWorldMap\:\:OnMapMouseDown ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapOnMapMouseMove: CScreenWorldMap\:\:OnMapMouseMove ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapOnMouseMove: CScreenWorldMap\:\:OnMouseMove ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapOnMouseWheel: CScreenWorldMap\:\:OnMouseWheel ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapOnRButtonDown: CScreenWorldMap\:\:OnRButtonDown ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapOnRButtonUp: CScreenWorldMap\:\:OnRButtonUp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapSetAreaPalette: CScreenWorldMap\:\:SetAreaPalette ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapSetChatEditBoxStatus: CScreenWorldMap\:\:SetChatEditBoxStatus ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapSetMapView: CScreenWorldMap\:\:SetMapView ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapSetSystemKeyCapsLock: CScreenWorldMap\:\:SetSystemKeyCapsLock ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapSetSystemKeyCtrl: CScreenWorldMap\:\:SetSystemKeyCtrl ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapSetSystemKeyShift: CScreenWorldMap\:\:SetSystemKeyShift ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapStartWorldMap: CScreenWorldMap\:\:StartWorldMap ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapStopWorldMap: CScreenWorldMap\:\:StopWorldMap ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapTimerAsynchronousUpdate: CScreenWorldMap\:\:TimerAsynchronousUpdate ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapTimerSynchronousUpdate: CScreenWorldMap\:\:TimerSynchronousUpdate ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapTravelToSelected: CScreenWorldMap\:\:TravelToSelected ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenWorldMapUpdateMainPanel: CScreenWorldMap\:\:UpdateMainPanel ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks**